Warn the user if the keyboard service is disabled #8095

zadjii-msft · 2020-10-29T13:20:33Z

Summary of the Pull Request

With this PR, the Terminal will check to make sure the "Touch, Keyboard and Handwriting Panel Service" is enabled at startup. If it isn't, then the Terminal won't be able to receive keyboard input (see #4448 and the 20 linked issues to that one).

References

See No keyboard input #4448 for more details

PR Checklist

Closes Add notice if service disabled: "Touch Keyboard and Handwriting Service" #7886
Should this make No keyboard input #4448 not-open as well?
I work here
[n/a] Tests added/passed
Docs: Add troubleshooting tips for the keyboard service dialog MicrosoftDocs/terminal#168

Validation Steps Performed

I manually set the service to "Disabled", restarted the machine, verified the dialog opens (and that I'm unable to type in the Terminal), then re-set the service to automatic and rebooted, and the dialog doesn't appear.

carlos-zamora · 2020-10-29T17:04:15Z

We should probably add a section in the docs under troubleshooting for this. Should we provide a link to that in the popup dialog?

Also, I'm guessing the answer is "no" but do we want a "disable this warning" setting?

DHowett · 2020-10-29T17:34:50Z

The way to disable this warning is to enable that service.

src/cascadia/TerminalApp/AppLogic.cpp

src/cascadia/TerminalApp/Resources/en-US/Resources.resw

src/cascadia/TerminalApp/AppLogic.cpp

src/cascadia/TerminalApp/Resources/en-US/Resources.resw

zadjii-msft · 2020-11-03T00:42:38Z

So as it turns out, the linter is set to auto pull the latest version, which is of course, broken. IMO, that's the last straw with the linter - I don't think we've gotten anything valuable from it frankly.

…he-keyboard

src/cascadia/TerminalApp/Resources/en-US/Resources.resw

src/cascadia/TerminalApp/TerminalPage.cpp

src/cascadia/TerminalApp/AppLogic.cpp

DHowett · 2020-11-04T18:54:55Z

src/cascadia/TerminalApp/TerminalPage.cpp

+        DWORD cchBuffer = 0;
+        GetServiceDisplayName(hManager.get(), TabletInputServiceKey.data(), nullptr, &cchBuffer);
+        std::wstring buffer;
+        cchBuffer += 1; // Add space for a null
+        buffer.resize(cchBuffer);
+
+        if (LOG_LAST_ERROR_IF(!GetServiceDisplayName(hManager.get(),
+                                                     TabletInputServiceKey.data(),
+                                                     buffer.data(),
+                                                     &cchBuffer)))
+        {
+            return winrt::hstring{ TabletInputServiceKey };
+        }


You might appreciate this helper!

std::wstring serviceName; wil::AdaptFixedSizeToAllocatedResult(serviceName, [hManager](PWSTR buffer, size_t size, size_t* needed) -> HRESULT { DWORD cchBuffer{ static_cast<DWORD>(size) }; BOOL const success = GetServiceDisplayName(hManager.get(), TabletInputServiceKey.data(), buffer, &cchBuffer); RETURN_LAST_ERROR_IF((success == FALSE) && (::GetLastError() != ERROR_INSUFFICIENT_BUFFER)); *needed = cchBuffer = 1; // +1 for the null terminator return S_OK; });

(this is a nit; I just think it's a cool helper!)

reckon you've gotta check the HR return from AdaptFixedSize...

DHowett · 2020-11-04T18:55:14Z

src/cascadia/TerminalApp/TerminalPage.cpp

+        DWORD cchBuffer = 0;
+        GetServiceDisplayName(hManager.get(), TabletInputServiceKey.data(), nullptr, &cchBuffer);
+        std::wstring buffer;
+        cchBuffer += 1; // Add space for a null
+        buffer.resize(cchBuffer);
+
+        if (LOG_LAST_ERROR_IF(!GetServiceDisplayName(hManager.get(),
+                                                     TabletInputServiceKey.data(),
+                                                     buffer.data(),
+                                                     &cchBuffer)))
+        {
+            return winrt::hstring{ TabletInputServiceKey };
+        }


reckon you've gotta check the HR return from AdaptFixedSize...

src/cascadia/TerminalApp/TerminalPage.cpp

Co-authored-by: Dustin L. Howett <duhowett@microsoft.com>

ghost · 2020-11-04T21:44:18Z

Hello @zadjii-msft!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

![kb-service-disabled](https://user-images.githubusercontent.com/18356694/97578533-eb792d80-19be-11eb-9b13-b771327a72a0.png) With this PR, the Terminal will check to make sure the "Touch, Keyboard and Handwriting Panel Service" is enabled at startup. If it isn't, then the Terminal won't be able to receive keyboard input (see #4448 and the 20 linked issues to that one). * See #4448 for more details * [x] Closes #7886 * [ ] Should this make #4448 not-open as well? * [x] I work here * [n/a] Tests added/passed * [x] Docs: MicrosoftDocs/terminal#168 I manually set the service to "Disabled", restarted the machine, verified the dialog opens (and that I'm unable to type in the Terminal), then re-set the service to automatic and rebooted, and the dialog doesn't appear. (cherry picked from commit d5d2b77)

ghost · 2020-11-11T18:07:35Z

🎉Windows Terminal v1.4.3141.0 has been released which incorporates this pull request.:tada:

Handy links:

ghost · 2020-11-11T18:13:32Z

🎉Windows Terminal Preview v1.5.3142.0 has been released which incorporates this pull request.:tada:

Handy links:

Add a setting to turn off the warning if 'Touch Keyboard and Handwriting Panel Service' is disabled. The service might not start in some case, and it doesn't affect the input in some computer. This PR turn off the warning even if the service is disabled. The setting name is "inputServiceWarning". ## Validation Steps Performed I manually set the service to "Disabled", restarted the Terminal, verified the warning up, then set "inputServiceWarning" to false and restarted the Terminal, and the warning didn't appear. References #8095 References #7886 (comment)

zadjii-msft added 2 commits October 29, 2020 05:34

This is a scratch sample of checking if the service is enabled

dd0b8b2

Pretty confident this will work, just gotta reboot to make sure

3c489d9

ghost added Area-User Interface Issues pertaining to the user interface of the Console or Terminal Issue-Task It's a feature request, but it doesn't really need a major design. Priority-3 A description (P3) Product-Terminal The new Windows Terminal. labels Oct 29, 2020

cleanup for review

20cf659

DHowett reviewed Oct 29, 2020

View reviewed changes

src/cascadia/TerminalApp/AppLogic.cpp Outdated Show resolved Hide resolved

miniksa reviewed Oct 30, 2020

View reviewed changes

src/cascadia/TerminalApp/Resources/en-US/Resources.resw Outdated Show resolved Hide resolved

KalleOlaviNiemitalo suggested changes Oct 30, 2020

View reviewed changes

ghost added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Oct 30, 2020

zadjii-msft self-assigned this Nov 2, 2020

zadjii-msft added 3 commits November 2, 2020 16:55

well at least this compiles

401956d

Make it actually work, silly Win32 APIs not leaving space for a NULL

2e502a9

You want it in XAML, here it is in XAML

5d6b40c

zadjii-msft added a commit to MicrosoftDocs/terminal that referenced this pull request Nov 3, 2020

Add troubleshooting tips for the dialog in microsoft/terminal#8095

5035bda

zadjii-msft mentioned this pull request Nov 3, 2020

Add troubleshooting tips for the keyboard service dialog MicrosoftDocs/terminal#168

Merged

zadjii-msft assigned DHowett and miniksa and unassigned zadjii-msft Nov 3, 2020

Merge branch 'main' into dev/migrie/f/7886-warn-if-youve-turned-off-t…

815b8cd

…he-keyboard

miniksa reviewed Nov 4, 2020

View reviewed changes

src/cascadia/TerminalApp/Resources/en-US/Resources.resw Outdated Show resolved Hide resolved

miniksa reviewed Nov 4, 2020

View reviewed changes

src/cascadia/TerminalApp/TerminalPage.cpp Outdated Show resolved Hide resolved

miniksa reviewed Nov 4, 2020

View reviewed changes

src/cascadia/TerminalApp/TerminalPage.cpp Outdated Show resolved Hide resolved

zadjii-msft commented Nov 4, 2020

View reviewed changes

src/cascadia/TerminalApp/AppLogic.cpp Outdated Show resolved Hide resolved

Update src/cascadia/TerminalApp/AppLogic.cpp

f1034f9

Make miniksa happy

93c6117

DHowett reviewed Nov 4, 2020

View reviewed changes

DHowett approved these changes Nov 4, 2020

View reviewed changes

Update src/cascadia/TerminalApp/TerminalPage.cpp

3e15cad

Co-authored-by: Dustin L. Howett <duhowett@microsoft.com>

zadjii-msft unassigned DHowett Nov 4, 2020

DHowett approved these changes Nov 4, 2020

View reviewed changes

miniksa approved these changes Nov 4, 2020

View reviewed changes

zadjii-msft added the AutoMerge Marked for automatic merge by the bot when requirements are met label Nov 4, 2020

ghost merged commit d5d2b77 into main Nov 4, 2020

ghost deleted the dev/migrie/f/7886-warn-if-youve-turned-off-the-keyboard branch November 4, 2020 21:44

ghost mentioned this pull request Nov 11, 2020

Add notice if service disabled: "Touch Keyboard and Handwriting Service" #7886

Closed

WVVxm mentioned this pull request Feb 3, 2021

Control 'Touch Keyboard and Handwriting Panel Service' warning #9015

Merged

6 tasks

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Warn the user if the keyboard service is disabled #8095

Warn the user if the keyboard service is disabled #8095

zadjii-msft commented Oct 29, 2020 •

edited

Loading

carlos-zamora commented Oct 29, 2020

DHowett commented Oct 29, 2020

zadjii-msft commented Nov 3, 2020

DHowett Nov 4, 2020 •

edited

Loading

DHowett Nov 4, 2020

DHowett Nov 4, 2020

ghost commented Nov 4, 2020

ghost commented Nov 11, 2020

ghost commented Nov 11, 2020

Warn the user if the keyboard service is disabled #8095

Warn the user if the keyboard service is disabled #8095

Conversation

zadjii-msft commented Oct 29, 2020 • edited Loading

Summary of the Pull Request

References

PR Checklist

Validation Steps Performed

carlos-zamora commented Oct 29, 2020

DHowett commented Oct 29, 2020

zadjii-msft commented Nov 3, 2020

DHowett Nov 4, 2020 • edited Loading

Choose a reason for hiding this comment

DHowett Nov 4, 2020

Choose a reason for hiding this comment

DHowett Nov 4, 2020

Choose a reason for hiding this comment

ghost commented Nov 4, 2020

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented Nov 11, 2020

ghost commented Nov 11, 2020

zadjii-msft commented Oct 29, 2020 •

edited

Loading

DHowett Nov 4, 2020 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.